home *** CD-ROM | disk | FTP | other *** search
/ Skunkware 5 / Skunkware 5.iso / man / cat.1 / co.1 < prev    next >
Text File  |  1995-07-25  |  19KB  |  463 lines
  1.  
  2.  
  3.  
  4. CO(1)                                                       CO(1)
  5.  
  6.  
  7. NNAAMMEE
  8.        co - check out RCS revisions
  9.  
  10. SSYYNNOOPPSSIISS
  11.        ccoo [_o_p_t_i_o_n_s] _f_i_l_e ...
  12.  
  13. DDEESSCCRRIIPPTTIIOONN
  14.        ccoo  retrieves  a revision from each RCS file and stores it
  15.        into the corresponding working file.
  16.  
  17.        Pathnames matching an RCS suffix  denote  RCS  files;  all
  18.        others   denote   working  files.   Names  are  paired  as
  19.        explained in ccii(1).
  20.  
  21.        Revisions of an RCS file may  be  checked  out  locked  or
  22.        unlocked.    Locking   a   revision  prevents  overlapping
  23.        updates.  A revision checked out for reading or processing
  24.        (e.g.,  compiling) need not be locked.  A revision checked
  25.        out for editing and later checkin must normally be locked.
  26.        Checkout  with locking fails if the revision to be checked
  27.        out is currently locked by another user.  (A lock  may  be
  28.        broken  with rrccss(1).)  Checkout with locking also requires
  29.        the caller to be on the  access  list  of  the  RCS  file,
  30.        unless  he  is  the owner of the file or the superuser, or
  31.        the access list is empty.  Checkout without locking is not
  32.        subject to accesslist restrictions, and is not affected by
  33.        the presence of locks.
  34.  
  35.        A revision is selected by options for revision  or  branch
  36.        number,  checkin  date/time,  author,  or state.  When the
  37.        selection options are applied in combination, ccoo retrieves
  38.        the  latest  revision that satisfies all of them.  If none
  39.        of the selection options is specified,  ccoo  retrieves  the
  40.        latest revision on the default branch (normally the trunk,
  41.        see the --bb option of rrccss(1)).  A revision or branch number
  42.        may  be attached to any of the options --ff, --II, --ll, --MM, --pp,
  43.        --qq, --rr, or --uu.  The options --dd (date), --ss (state), and  --ww
  44.        (author)  retrieve  from  a  single  branch,  the _s_e_l_e_c_t_e_d
  45.        branch, which is either specified by one of --ff,,  ...,  --uu,
  46.        or the default branch.
  47.  
  48.        A ccoo command applied to an RCS file with no revisions cre-
  49.        ates a zero-length working file.  ccoo always performs  key-
  50.        word substitution (see below).
  51.  
  52. OOPPTTIIOONNSS
  53.        --rr[_r_e_v]
  54.               retrieves  the latest revision whose number is less
  55.               than or equal to _r_e_v_.  If _r_e_v  indicates  a  branch
  56.               rather than a revision, the latest revision on that
  57.               branch is retrieved.  If _r_e_v is omitted, the latest
  58.               revision  on  the default branch (see the --bb option
  59.               of rrccss(1)) is retrieved.  If _r_e_v is  $$,  ccoo  deter-
  60.               mines  the  revision  number from keyword values in
  61.  
  62.  
  63.  
  64. GNU                         1991/08/19                          1
  65.  
  66.  
  67.  
  68.  
  69.  
  70. CO(1)                                                       CO(1)
  71.  
  72.  
  73.               the working file.  Otherwise, a  revision  is  com-
  74.               posed  of  one  or  more numeric or symbolic fields
  75.               separated by periods.  The numeric equivalent of  a
  76.               symbolic  field  is specified with the --nn option of
  77.               the commands ccii(1) and rrccss(1).
  78.  
  79.        --ll[_r_e_v]
  80.               same as --rr, except that it also locks the retrieved
  81.               revision for the caller.
  82.  
  83.        --uu[_r_e_v]
  84.               same  as  --rr,  except that it unlocks the retrieved
  85.               revision if it was locked by the caller.  If _r_e_v is
  86.               omitted,  --uu  retrieves  the revision locked by the
  87.               caller, if there is one;  otherwise,  it  retrieves
  88.               the latest revision on the default branch.
  89.  
  90.        --ff[_r_e_v]
  91.               forces  the overwriting of the working file; useful
  92.               in connection with --qq.  See also FILE MODES  below.
  93.  
  94.        --kkkkvv   Generate  keyword  strings  using the default form,
  95.               e.g. $$RReevviissiioonn:: 55..77 $$ for the RReevviissiioonn keyword.   A
  96.               locker's  name  is  inserted  in  the  value of the
  97.               HHeeaaddeerr, IIdd, and LLoocckkeerr keyword strings  only  as  a
  98.               file  is  being  locked,  i.e.  by ccii --ll and ccoo --ll.
  99.               This is the default.
  100.  
  101.        --kkkkvvll  Like --kkkkvv, except that a locker's  name  is  always
  102.               inserted if the given revision is currently locked.
  103.  
  104.        --kkkk    Generate only keyword  names  in  keyword  strings;
  105.               omit their values.  See KEYWORD SUBSTITUTION below.
  106.               For example, for the RReevviissiioonn keyword, generate the
  107.               string  $$RReevviissiioonn$$  instead  of  $$RReevviissiioonn::  55..77 $$.
  108.               This option is useful to ignore differences due  to
  109.               keyword substitution when comparing different revi-
  110.               sions of a file.
  111.  
  112.        --kkoo    Generate the old keyword  string,  present  in  the
  113.               working  file  just  before it was checked in.  For
  114.               example, for the  RReevviissiioonn  keyword,  generate  the
  115.               string $$RReevviissiioonn:: 11..11 $$ instead of $$RReevviissiioonn:: 55..77 $$
  116.               if that is how the string appeared  when  the  file
  117.               was checked in.  This can be useful for binary file
  118.               formats that cannot tolerate any  changes  to  sub-
  119.               strings  that  happen  to  take the form of keyword
  120.               strings.
  121.  
  122.        --kkvv    Generate only keyword values for  keyword  strings.
  123.               For example, for the RReevviissiioonn keyword, generate the
  124.               string 55..77 instead of $$RReevviissiioonn:: 55..77 $$.   This  can
  125.               help  generate files in programming languages where
  126.               it  is  hard  to  strip  keyword  delimiters   like
  127.  
  128.  
  129.  
  130. GNU                         1991/08/19                          2
  131.  
  132.  
  133.  
  134.  
  135.  
  136. CO(1)                                                       CO(1)
  137.  
  138.  
  139.               $$RReevviissiioonn:: $$  from a string.  However, further key-
  140.               word substitution cannot be performed once the key-
  141.               word  names  are  removed, so this option should be
  142.               used with care.  Because of this danger  of  losing
  143.               keywords,  this  option cannot be combined with --ll,
  144.               and the owner write permission of the working  file
  145.               is turned off; to edit the file later, check it out
  146.               again without --kkvv.
  147.  
  148.        --pp[_r_e_v]
  149.               prints the retrieved revision on the standard  out-
  150.               put  rather  than  storing  it in the working file.
  151.               This option is useful when ccoo is part of a pipe.
  152.  
  153.        --qq[_r_e_v]
  154.               quiet mode; diagnostics are not printed.
  155.  
  156.        --II[_r_e_v]
  157.               interactive mode; the user is  prompted  and  ques-
  158.               tioned  even  if the standard input is not a termi-
  159.               nal.
  160.  
  161.        --dd_d_a_t_e retrieves  the  latest  revision  on  the  selected
  162.               branch  whose  checkin  date/time  is  less than or
  163.               equal to _d_a_t_e_.  The date and time may be  given  in
  164.               free  format.   The  time  zone LLTT stands for local
  165.               time; other common time zone names are  understood.
  166.               For  example, the following _d_a_t_es are equivalent if
  167.               local time is January 11, 1990, 8pm  Pacific  Stan-
  168.               dard  Time, eight hours west of Coordinated Univer-
  169.               sal Time (UTC):
  170.  
  171.                      88::0000 ppmm lltt
  172.                      44::0000 AAMM,, JJaann.. 1122,, 11999900           note: default is UTC
  173.                      11999900//0011//1122 0044::0000::0000              RCS date format
  174.                      TThhuu JJaann 1111 2200::0000::0000 11999900 LLTT      output of ccttiimmee(3) + LLTT
  175.                      TThhuu JJaann 1111 2200::0000::0000 PPSSTT 11999900     output of ddaattee(1)
  176.                      FFrrii JJaann 1122 0044::0000::0000 GGMMTT 11999900
  177.                      TThhuu,, 1111 JJaann 11999900 2200::0000::0000 --00880000
  178.                      FFrrii--JJSSTT,, 11999900,, 11ppmm JJaann 1122
  179.                      1122--JJaannuuaarryy--11999900,, 0044::0000--WWEETT
  180.  
  181.               Most fields in the date and time may be  defaulted.
  182.               The  default  time zone is UTC.  The other defaults
  183.               are determined in the order year, month, day, hour,
  184.               minute, and second (most to least significant).  At
  185.               least one of these fields must  be  provided.   For
  186.               omitted fields that are of higher significance than
  187.               the highest provided field, the time zone's current
  188.               values  are assumed.  For all other omitted fields,
  189.               the lowest possible values are assumed.  For  exam-
  190.               ple, the date 2200,, 1100::3300 defaults to 10:30:00 UTC of
  191.               the 20th of the UTC time zone's current  month  and
  192.               year.   The date/time must be quoted if it contains
  193.  
  194.  
  195.  
  196. GNU                         1991/08/19                          3
  197.  
  198.  
  199.  
  200.  
  201.  
  202. CO(1)                                                       CO(1)
  203.  
  204.  
  205.               spaces.
  206.  
  207.        --MM[_r_e_v]
  208.               Set the modification time on the new  working  file
  209.               to be the date of the retrieved revision.  Use this
  210.               option with care; it can confuse mmaakkee(1).
  211.  
  212.        --ss_s_t_a_t_e
  213.               retrieves  the  latest  revision  on  the  selected
  214.               branch whose state is set to _s_t_a_t_e_.
  215.  
  216.        --ww[_l_o_g_i_n]
  217.               retrieves  the  latest  revision  on  the  selected
  218.               branch which was checked in by the user with  login
  219.               name  _l_o_g_i_n_.  If the argument _l_o_g_i_n is omitted, the
  220.               caller's login is assumed.
  221.  
  222.        --jj_j_o_i_n_l_i_s_t
  223.               generates a new revision which is the join  of  the
  224.               revisions  on  _j_o_i_n_l_i_s_t_.   This  option  is largely
  225.               obsoleted by rrccssmmeerrggee(1) but is retained for  back-
  226.               wards compatibility.
  227.  
  228.               The  _j_o_i_n_l_i_s_t is a comma-separated list of pairs of
  229.               the form _r_e_v_2::_r_e_v_3_, where _r_e_v_2 and _r_e_v_3  are  (sym-
  230.               bolic  or  numeric) revision numbers.  For the ini-
  231.               tial such pair, _r_e_v_1 denotes the revision  selected
  232.               by  the  above  options --ff,, ..., --ww.  For all other
  233.               pairs, _r_e_v_1 denotes the revision generated  by  the
  234.               previous  pair.   (Thus,  the  output  of  one join
  235.               becomes the input to the next.)
  236.  
  237.               For each pair, ccoo joins  revisions  _r_e_v_1  and  _r_e_v_3
  238.               with  respect to _r_e_v_2_.  This means that all changes
  239.               that transform _r_e_v_2 into _r_e_v_1 are applied to a copy
  240.               of  _r_e_v_3_.   This is particularly useful if _r_e_v_1 and
  241.               _r_e_v_3 are the ends of two branches that have _r_e_v_2 as
  242.               a  common  ancestor.  If _r_e_v_1<_r_e_v_2<_r_e_v_3 on the same
  243.               branch, joining generates a new revision  which  is
  244.               like _r_e_v_3_, but with all changes that lead from _r_e_v_1
  245.               to _r_e_v_2 undone.  If changes from _r_e_v_2 to _r_e_v_1 over-
  246.               lap  with  changes  from  _r_e_v_2  to _r_e_v_3_, ccoo reports
  247.               overlaps as described in mmeerrggee(1).
  248.  
  249.               For the initial pair, _r_e_v_2  may  be  omitted.   The
  250.               default  is  the  common  ancestor.   If any of the
  251.               arguments indicate branches, the  latest  revisions
  252.               on  those branches are assumed.  The options --ll and
  253.               --uu lock or unlock _r_e_v_1_.
  254.  
  255.        --VV_n    Emulate RCS version _n_, where _n may be 33, 44,  or  55.
  256.               This  may  be  useful  when interchanging RCS files
  257.               with others who are running older versions of  RCS.
  258.               To see which version of RCS your correspondents are
  259.  
  260.  
  261.  
  262. GNU                         1991/08/19                          4
  263.  
  264.  
  265.  
  266.  
  267.  
  268. CO(1)                                                       CO(1)
  269.  
  270.  
  271.               running, have them invoke rrlloogg on an RCS  file;  if
  272.               none  of  the first few lines of output contain the
  273.               string bbrraanncchh:: it is version 3; if the dates' years
  274.               have  just  two digits, it is version 4; otherwise,
  275.               it is version 5.  An RCS file generated while  emu-
  276.               lating  version 3 will lose its default branch.  An
  277.               RCS revision generated while emulating version 4 or
  278.               earlier  will have a timestamp that is off by up to
  279.               13 hours.  A  revision  extracted  while  emulating
  280.               version 4 or earlier will contain dates of the form
  281.               _y_y//_m_m//_d_d instead of _y_y_y_y//_m_m//_d_d and may also contain
  282.               different  white  space  in  the  substitution  for
  283.               $$LLoogg$$.
  284.  
  285.        --xx_s_u_f_f_i_x_e_s
  286.               Use _s_u_f_f_i_x_e_s to characterize RCS files.  See  ccii(1)
  287.               for details.
  288.  
  289. KKEEYYWWOORRDD SSUUBBSSTTIITTUUTTIIOONN
  290.        Strings  of  the form $$_k_e_y_w_o_r_d$$ and $$_k_e_y_w_o_r_d::_._._.$$ embedded
  291.        in the text are replaced with strings of  the  form  $$_k_e_y_-
  292.        _w_o_r_d::_v_a_l_u_e$$  where  _k_e_y_w_o_r_d  and  _v_a_l_u_e  are  pairs listed
  293.        below.  Keywords may be embedded  in  literal  strings  or
  294.        comments to identify a revision.
  295.  
  296.        Initially,  the user enters strings of the form $$_k_e_y_w_o_r_d$$_.
  297.        On checkout, ccoo replaces these strings with strings of the
  298.        form $$_k_e_y_w_o_r_d::_v_a_l_u_e$$_.  If a revision containing strings of
  299.        the latter form is checked back in, the value fields  will
  300.        be  replaced  during the next checkout.  Thus, the keyword
  301.        values are automatically updated on checkout.  This  auto-
  302.        matic substitution can be modified by the --kk options.
  303.  
  304.        Keywords and their corresponding values:
  305.  
  306.        $$AAuutthhoorr$$
  307.               The login name of the user who checked in the revi-
  308.               sion.
  309.  
  310.        $$DDaattee$$ The date and time (UTC) the  revision  was  checked
  311.               in.
  312.  
  313.        $$HHeeaaddeerr$$
  314.               A  standard  header containing the full pathname of
  315.               the RCS file, the revision number, the date  (UTC),
  316.               the  author, the state, and the locker (if locked).
  317.  
  318.        $$IIdd$$   Same as $$HHeeaaddeerr$$, except that the RCS  filename  is
  319.               without a path.
  320.  
  321.        $$LLoocckkeerr$$
  322.               The  login name of the user who locked the revision
  323.               (empty if not locked).
  324.  
  325.  
  326.  
  327.  
  328. GNU                         1991/08/19                          5
  329.  
  330.  
  331.  
  332.  
  333.  
  334. CO(1)                                                       CO(1)
  335.  
  336.  
  337.        $$LLoogg$$  The log message supplied during  checkin,  preceded
  338.               by  a header containing the RCS filename, the revi-
  339.               sion  number,  the  author,  and  the  date  (UTC).
  340.               Existing  log  messages are _n_o_t replaced.  Instead,
  341.               the new log message is  inserted  after  $$LLoogg::...$$.
  342.               This  is  useful for accumulating a complete change
  343.               log in a source file.
  344.  
  345.        $$RRCCSSffiillee$$
  346.               The name of the RCS file without a path.
  347.  
  348.        $$RReevviissiioonn$$
  349.               The revision number assigned to the revision.
  350.  
  351.        $$SSoouurrccee$$
  352.               The full pathname of the RCS file.
  353.  
  354.        $$SSttaattee$$
  355.               The state assigned to  the  revision  with  the  --ss
  356.               option of rrccss(1) or ccii(1).
  357.  
  358. FFIILLEE MMOODDEESS
  359.        The working file inherits the read and execute permissions
  360.        from the RCS file.  In addition, the owner  write  permis-
  361.        sion  is  turned  on,  unless  --kkvv  is  set or the file is
  362.        checked out unlocked and locking is  set  to  strict  (see
  363.        rrccss(1)).
  364.  
  365.        If a file with the name of the working file exists already
  366.        and has write permission, ccoo aborts the  checkout,  asking
  367.        beforehand  if  possible.  If the existing working file is
  368.        not writable or --ff is given, the working file  is  deleted
  369.        without asking.
  370.  
  371. FFIILLEESS
  372.        ccoo  accesses files much as ccii(1) does, except that it does
  373.        not need to read the working file.
  374.  
  375. EENNVVIIRROONNMMEENNTT
  376.        RRCCSSIINNIITT
  377.               options prepended to the argument  list,  separated
  378.               by spaces.  See ccii(1) for details.
  379.  
  380. DDIIAAGGNNOOSSTTIICCSS
  381.        The  RCS  pathname, the working pathname, and the revision
  382.        number retrieved are written  to  the  diagnostic  output.
  383.        The exit status is zero if and only if all operations were
  384.        successful.
  385.  
  386. IIDDEENNTTIIFFIICCAATTIIOONN
  387.        Author: Walter F. Tichy.
  388.        Revision Number: 5.7; Release Date: 1991/08/19.
  389.        Copyright (C) 1982, 1988, 1989 by Walter F. Tichy.
  390.        Copyright (C) 1990, 1991 by Paul Eggert.
  391.  
  392.  
  393.  
  394. GNU                         1991/08/19                          6
  395.  
  396.  
  397.  
  398.  
  399.  
  400. CO(1)                                                       CO(1)
  401.  
  402.  
  403. SSEEEE AALLSSOO
  404.        ci(1), ctime(3), date(1), ident(1), make(1), rcs(1), rcsd-
  405.        iff(1), rcsintro(1), rcsmerge(1), rlog(1), rcsfile(5)
  406.        Walter  F.  Tichy,  RCS--A  System  for  Version  Control,
  407.        _S_o_f_t_w_a_r_e_-_-_P_r_a_c_t_i_c_e  _&  _E_x_p_e_r_i_e_n_c_e  1155,  7   (July   1985),
  408.        637-654.
  409.  
  410. LLIIMMIITTSS
  411.        Links to the RCS and working files are not preserved.
  412.  
  413.        There  is  no way to selectively suppress the expansion of
  414.        keywords, except by writing them  differently.   In  nroff
  415.        and troff, this is done by embedding the null-character \\&&
  416.        into the keyword.
  417.  
  418. BBUUGGSS
  419.        The --dd option sometimes gets confused, and accepts no date
  420.        before 1970.
  421.  
  422.  
  423.  
  424.  
  425.  
  426.  
  427.  
  428.  
  429.  
  430.  
  431.  
  432.  
  433.  
  434.  
  435.  
  436.  
  437.  
  438.  
  439.  
  440.  
  441.  
  442.  
  443.  
  444.  
  445.  
  446.  
  447.  
  448.  
  449.  
  450.  
  451.  
  452.  
  453.  
  454.  
  455.  
  456.  
  457.  
  458.  
  459.  
  460. GNU                         1991/08/19                          7
  461.  
  462.  
  463.